<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">

<title>class RDoc::RubygemsHook - rdoc: Ruby Standard Library Documentation</title>


<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>

<script src="../js/jquery-3.2.0.min.js"></script>

<script src="../js/vue.min.js"></script>
<script src="../js/js.cookie.min.js"></script>

<link href="../css/fonts.css" rel="stylesheet">
<link id='rdoccss' href="../css/rdoc.css" rel="stylesheet">
<link href="../css/carbon17.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "../";
  var index_rel_prefix = "../";
  var darkModeCsseHref = "../css/rdoc-dm.css"
  var defaultModeCssHref = "../css/rdoc.css"
  // var cssDarkmode = Cookies.get('darkmode');
  
  if( Cookies.get("darkmode") == "true") {
	$('#rdoccss').attr("href", darkModeCsseHref);
}

//  https://cssdeck.com/blog/simple-jquery-stylesheet-switcher/

document.write('<style type="text/css">body{display:none}</style>');

</script>


</head>
<body id="top" role="document" class="class">
  <!-- this is class.html -->

  <div id='actionbar' >
    <div class='wrapper mdiv'>
      <ul class='grids g0'></ul>
    </div> 
    <!-- VERSION HEADER for 3.3.0.preview2 NOT FOUND -->
  </div> <!-- end action bar -->

  <div class='wrapper hdiv'>

    


    <nav id='vapp' role="navigation">
    <div id="project-navigation">
      <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2><a href="../index.html" rel="home">Home</a></h2>

  <div id="table-of-contents-navigation"  >
    <a href="../table_of_contents.html#pages">Pages</a>
    <a href="../table_of_contents.html#classes">Classes</a>
    <a href="../table_of_contents.html#methods">Methods</a>
  </div>
</div>

      <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

    </div>


    

    <button id='toggleThing' @click="toggleNav()" >Show/hide navigation</button>
    <div :class="isOpen ? 'block' : 'hidden' " id='toggleMe'>
      <div id="class-metadata">
        
        
<div id="parent-class-section" class="nav-section">
  <h3>Parent</h3>

  <p class="link"><a href="../Object.html">Object</a>
</div>

        
<div id="includes-section" class="nav-section">
  <h3>Included Modules</h3>

  <ul class="link-list">
    <li><span class="include">Gem::UserInteraction</span>
  </ul>
</div>

        
<div id="extends-section" class="nav-section">
  <h3>Extended With Modules</h3>

  <ul class="link-list">
    <li><span class="extend">Gem::UserInteraction</span>
  </ul>
</div>

        
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    <li ><a href="#method-c-generation_hook">::generation_hook</a>
    <li ><a href="#method-c-load_rdoc">::load_rdoc</a>
    <li ><a href="#method-c-new">::new</a>
    <li ><a href="#method-i-delete_legacy_args">#delete_legacy_args</a>
    <li ><a href="#method-i-document">#document</a>
    <li ><a href="#method-i-generate">#generate</a>
    <li ><a href="#method-i-rdoc_installed-3F">#rdoc_installed?</a>
    <li ><a href="#method-i-remove">#remove</a>
    <li ><a href="#method-i-ri_installed-3F">#ri_installed?</a>
    <li ><a href="#method-i-setup">#setup</a>
  </ul>
</div>

      </div>
     </div>
    </nav>


    <div id='extraz'><div class='adzbox-index'  >
      
     </div>         
    </div>

    <main role="main" aria-labelledby="class-RDoc::RubygemsHook">
    <h1 id="class-RDoc::RubygemsHook" class="class">
      class RDoc::RubygemsHook
    </h1>

    <section class="description">
    
<p>Gem::RDoc provides methods to generate <a href="../RDoc.html"><code>RDoc</code></a> and ri data for installed gems upon gem installation.</p>

<p>This file is automatically required by RubyGems 1.9 and newer.</p>

    </section>

      <section id="5Buntitled-5D" class="documentation-section">



        <section class="attribute-method-details" class="method-section">
        <header>
        <h3>Attributes</h3>
        </header>

          <div id="attribute-c-rdoc_version" class="method-detail">
            <div class="method-heading attribute-method-heading">
              <span class="method-name">rdoc_version</span><span
                class="attribute-access-type">[R]</span>
            </div>

            <div class="method-description">
              <p>Loaded version of <a href="../RDoc.html"><code>RDoc</code></a>.  Set by <a href="RubygemsHook.html#method-c-load_rdoc"><code>::load_rdoc</code></a></p>
              </div>
            </div>
          <div id="attribute-i-force" class="method-detail">
            <div class="method-heading attribute-method-heading">
              <span class="method-name">force</span><span
                class="attribute-access-type">[RW]</span>
            </div>

            <div class="method-description">
              <p>Force installation of documentation?</p>
              </div>
            </div>
          <div id="attribute-i-generate_rdoc" class="method-detail">
            <div class="method-heading attribute-method-heading">
              <span class="method-name">generate_rdoc</span><span
                class="attribute-access-type">[RW]</span>
            </div>

            <div class="method-description">
              <p>Generate rdoc?</p>
              </div>
            </div>
          <div id="attribute-i-generate_ri" class="method-detail">
            <div class="method-heading attribute-method-heading">
              <span class="method-name">generate_ri</span><span
                class="attribute-access-type">[RW]</span>
            </div>

            <div class="method-description">
              <p>Generate ri data?</p>
              </div>
            </div>
            </section>


                <section id="public-class-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Public Class Methods</h3>
                </header>

                  <div id="method-c-generation_hook" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">generation_hook</span><span
                                class="method-args">(installer, specs)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Post installs hook that generates documentation for each specification in <code>specs</code></p>

                              <div class="method-source-code" id="generation_hook-source">
            <pre><span class="ruby-comment"># File rdoc/rubygems_hook.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">generation_hook</span> <span class="ruby-identifier">installer</span>, <span class="ruby-identifier">specs</span>
  <span class="ruby-identifier">start</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
  <span class="ruby-identifier">types</span> = <span class="ruby-identifier">installer</span>.<span class="ruby-identifier">document</span>

  <span class="ruby-identifier">generate_rdoc</span> = <span class="ruby-identifier">types</span>.<span class="ruby-identifier">include?</span> <span class="ruby-string">&#39;rdoc&#39;</span>
  <span class="ruby-identifier">generate_ri</span>   = <span class="ruby-identifier">types</span>.<span class="ruby-identifier">include?</span> <span class="ruby-string">&#39;ri&#39;</span>

  <span class="ruby-identifier">specs</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">spec</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">new</span>(<span class="ruby-identifier">spec</span>, <span class="ruby-identifier">generate_rdoc</span>, <span class="ruby-identifier">generate_ri</span>).<span class="ruby-identifier">generate</span>
  <span class="ruby-keyword">end</span>

  <span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">generate_rdoc</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">generate_ri</span>

  <span class="ruby-identifier">duration</span> = (<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">start</span>).<span class="ruby-identifier">to_i</span>
  <span class="ruby-identifier">names</span>    = <span class="ruby-identifier">specs</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&amp;</span><span class="ruby-value">:name</span>).<span class="ruby-identifier">join</span> <span class="ruby-string">&#39;, &#39;</span>

  <span class="ruby-identifier">say</span> <span class="ruby-node">&quot;Done installing documentation for #{names} after #{duration} seconds&quot;</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-c-load_rdoc" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">load_rdoc</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Loads the <a href="../RDoc.html"><code>RDoc</code></a> generator</p>

                              <div class="method-source-code" id="load_rdoc-source">
            <pre><span class="ruby-comment"># File rdoc/rubygems_hook.rb, line 70</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">load_rdoc</span>
  <span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@rdoc_version</span>

  <span class="ruby-identifier">require_relative</span> <span class="ruby-string">&#39;rdoc&#39;</span>

  <span class="ruby-ivar">@rdoc_version</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Version</span>.<span class="ruby-identifier">new</span> <span class="ruby-operator">::</span><span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-c-new" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">new</span><span
                                class="method-args">(spec, generate_rdoc = false, generate_ri = true)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Creates a new documentation generator for <code>spec</code>.  <a href="../RDoc.html"><code>RDoc</code></a> and ri data generation can be enabled or disabled through <code>generate_rdoc</code> and <code>generate_ri</code> respectively.</p>

<p>Only <code>generate_ri</code> is enabled by default.</p>

                              <div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File rdoc/rubygems_hook.rb, line 85</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span> <span class="ruby-identifier">spec</span>, <span class="ruby-identifier">generate_rdoc</span> = <span class="ruby-keyword">false</span>, <span class="ruby-identifier">generate_ri</span> = <span class="ruby-keyword">true</span>
  <span class="ruby-ivar">@doc_dir</span>   = <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">doc_dir</span>
  <span class="ruby-ivar">@force</span>     = <span class="ruby-keyword">false</span>
  <span class="ruby-ivar">@rdoc</span>      = <span class="ruby-keyword">nil</span>
  <span class="ruby-ivar">@spec</span>      = <span class="ruby-identifier">spec</span>

  <span class="ruby-ivar">@generate_rdoc</span> = <span class="ruby-identifier">generate_rdoc</span>
  <span class="ruby-ivar">@generate_ri</span>   = <span class="ruby-identifier">generate_ri</span>

  <span class="ruby-ivar">@rdoc_dir</span> = <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">doc_dir</span> <span class="ruby-string">&#39;rdoc&#39;</span>
  <span class="ruby-ivar">@ri_dir</span>   = <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">doc_dir</span> <span class="ruby-string">&#39;ri&#39;</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

                <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Public Instance Methods</h3>
                </header>

                  <div id="method-i-delete_legacy_args" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">delete_legacy_args</span><span
                                class="method-args">(args)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Removes legacy rdoc arguments from <code>args</code></p>

                              <div class="method-source-code" id="delete_legacy_args-source">
            <pre><span class="ruby-comment"># File rdoc/rubygems_hook.rb, line 103</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete_legacy_args</span> <span class="ruby-identifier">args</span>
  <span class="ruby-identifier">args</span>.<span class="ruby-identifier">delete</span> <span class="ruby-string">&#39;--inline-source&#39;</span>
  <span class="ruby-identifier">args</span>.<span class="ruby-identifier">delete</span> <span class="ruby-string">&#39;--promiscuous&#39;</span>
  <span class="ruby-identifier">args</span>.<span class="ruby-identifier">delete</span> <span class="ruby-string">&#39;-p&#39;</span>
  <span class="ruby-identifier">args</span>.<span class="ruby-identifier">delete</span> <span class="ruby-string">&#39;--one-file&#39;</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-document" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">document</span><span
                                class="method-args">(generator, options, destination)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Generates documentation using the named <code>generator</code> (“darkfish” or “ri”) and following the given <code>options</code>.</p>

<p>Documentation will be generated into <code>destination</code></p>

                              <div class="method-source-code" id="document-source">
            <pre><span class="ruby-comment"># File rdoc/rubygems_hook.rb, line 116</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">document</span> <span class="ruby-identifier">generator</span>, <span class="ruby-identifier">options</span>, <span class="ruby-identifier">destination</span>
  <span class="ruby-identifier">generator_name</span> = <span class="ruby-identifier">generator</span>

  <span class="ruby-identifier">options</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">dup</span>
  <span class="ruby-identifier">options</span>.<span class="ruby-identifier">exclude</span> <span class="ruby-operator">||=</span> [] <span class="ruby-comment"># TODO maybe move to RDoc::Options#finish</span>
  <span class="ruby-identifier">options</span>.<span class="ruby-identifier">setup_generator</span> <span class="ruby-identifier">generator</span>
  <span class="ruby-identifier">options</span>.<span class="ruby-identifier">op_dir</span> = <span class="ruby-identifier">destination</span>
  <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span> <span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">full_gem_path</span> <span class="ruby-keyword">do</span>
    <span class="ruby-identifier">options</span>.<span class="ruby-identifier">finish</span>
  <span class="ruby-keyword">end</span>

  <span class="ruby-identifier">generator</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">generator</span>.<span class="ruby-identifier">new</span> <span class="ruby-ivar">@rdoc</span>.<span class="ruby-identifier">store</span>, <span class="ruby-identifier">options</span>

  <span class="ruby-ivar">@rdoc</span>.<span class="ruby-identifier">options</span> = <span class="ruby-identifier">options</span>
  <span class="ruby-ivar">@rdoc</span>.<span class="ruby-identifier">generator</span> = <span class="ruby-identifier">generator</span>

  <span class="ruby-identifier">say</span> <span class="ruby-node">&quot;Installing #{generator_name} documentation for #{@spec.full_name}&quot;</span>

  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">op_dir</span>

  <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">op_dir</span> <span class="ruby-keyword">do</span>
    <span class="ruby-keyword">begin</span>
      <span class="ruby-ivar">@rdoc</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">current</span> = <span class="ruby-ivar">@rdoc</span>
      <span class="ruby-ivar">@rdoc</span>.<span class="ruby-identifier">generator</span>.<span class="ruby-identifier">generate</span>
    <span class="ruby-keyword">ensure</span>
      <span class="ruby-ivar">@rdoc</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">current</span> = <span class="ruby-keyword">nil</span>
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-generate" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">generate</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Generates <a href="../RDoc.html"><code>RDoc</code></a> and ri data</p>

                              <div class="method-source-code" id="generate-source">
            <pre><span class="ruby-comment"># File rdoc/rubygems_hook.rb, line 149</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">generate</span>
  <span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">default_gem?</span>
  <span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@generate_ri</span> <span class="ruby-keyword">or</span> <span class="ruby-ivar">@generate_rdoc</span>

  <span class="ruby-identifier">setup</span>

  <span class="ruby-identifier">options</span> = <span class="ruby-keyword">nil</span>

  <span class="ruby-identifier">args</span> = <span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">rdoc_options</span>
  <span class="ruby-identifier">args</span>.<span class="ruby-identifier">concat</span> <span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">source_paths</span>
  <span class="ruby-identifier">args</span>.<span class="ruby-identifier">concat</span> <span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">extra_rdoc_files</span>

  <span class="ruby-keyword">case</span> <span class="ruby-identifier">config_args</span> = <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>[<span class="ruby-value">:rdoc</span>]
  <span class="ruby-keyword">when</span> <span class="ruby-constant">String</span> <span class="ruby-keyword">then</span>
    <span class="ruby-identifier">args</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">concat</span> <span class="ruby-identifier">config_args</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">&#39; &#39;</span>)
  <span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span> <span class="ruby-keyword">then</span>
    <span class="ruby-identifier">args</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">concat</span> <span class="ruby-identifier">config_args</span>
  <span class="ruby-keyword">end</span>

  <span class="ruby-identifier">delete_legacy_args</span> <span class="ruby-identifier">args</span>

  <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span> <span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">full_gem_path</span> <span class="ruby-keyword">do</span>
    <span class="ruby-identifier">options</span> = <span class="ruby-operator">::</span><span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">Options</span>.<span class="ruby-identifier">new</span>
    <span class="ruby-identifier">options</span>.<span class="ruby-identifier">default_title</span> = <span class="ruby-node">&quot;#{@spec.full_name} Documentation&quot;</span>
    <span class="ruby-identifier">options</span>.<span class="ruby-identifier">parse</span> <span class="ruby-identifier">args</span>
  <span class="ruby-keyword">end</span>

  <span class="ruby-identifier">options</span>.<span class="ruby-identifier">quiet</span> = <span class="ruby-operator">!</span><span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">really_verbose</span>

  <span class="ruby-ivar">@rdoc</span> = <span class="ruby-identifier">new_rdoc</span>
  <span class="ruby-ivar">@rdoc</span>.<span class="ruby-identifier">options</span> = <span class="ruby-identifier">options</span>

  <span class="ruby-identifier">store</span> = <span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">Store</span>.<span class="ruby-identifier">new</span>
  <span class="ruby-identifier">store</span>.<span class="ruby-identifier">encoding</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">encoding</span>
  <span class="ruby-identifier">store</span>.<span class="ruby-identifier">dry_run</span>  = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">dry_run</span>
  <span class="ruby-identifier">store</span>.<span class="ruby-identifier">main</span>     = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">main_page</span>
  <span class="ruby-identifier">store</span>.<span class="ruby-identifier">title</span>    = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">title</span>

  <span class="ruby-ivar">@rdoc</span>.<span class="ruby-identifier">store</span> = <span class="ruby-identifier">store</span>

  <span class="ruby-identifier">say</span> <span class="ruby-node">&quot;Parsing documentation for #{@spec.full_name}&quot;</span>

  <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span> <span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">full_gem_path</span> <span class="ruby-keyword">do</span>
    <span class="ruby-ivar">@rdoc</span>.<span class="ruby-identifier">parse_files</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">files</span>
  <span class="ruby-keyword">end</span>

  <span class="ruby-identifier">document</span> <span class="ruby-string">&#39;ri&#39;</span>,       <span class="ruby-identifier">options</span>, <span class="ruby-ivar">@ri_dir</span> <span class="ruby-keyword">if</span>
    <span class="ruby-ivar">@generate_ri</span>   <span class="ruby-keyword">and</span> (<span class="ruby-ivar">@force</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">not</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span> <span class="ruby-ivar">@ri_dir</span>)

  <span class="ruby-identifier">document</span> <span class="ruby-string">&#39;darkfish&#39;</span>, <span class="ruby-identifier">options</span>, <span class="ruby-ivar">@rdoc_dir</span> <span class="ruby-keyword">if</span>
    <span class="ruby-ivar">@generate_rdoc</span> <span class="ruby-keyword">and</span> (<span class="ruby-ivar">@force</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">not</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span> <span class="ruby-ivar">@rdoc_dir</span>)
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-rdoc_installed-3F" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">rdoc_installed?</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Is rdoc documentation installed?</p>

                              <div class="method-source-code" id="rdoc_installed-3F-source">
            <pre><span class="ruby-comment"># File rdoc/rubygems_hook.rb, line 213</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rdoc_installed?</span>
  <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span> <span class="ruby-ivar">@rdoc_dir</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-remove" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">remove</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Removes generated <a href="../RDoc.html"><code>RDoc</code></a> and ri data</p>

                              <div class="method-source-code" id="remove-source">
            <pre><span class="ruby-comment"># File rdoc/rubygems_hook.rb, line 220</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">remove</span>
  <span class="ruby-identifier">base_dir</span> = <span class="ruby-ivar">@spec</span>.<span class="ruby-identifier">base_dir</span>

  <span class="ruby-identifier">raise</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">FilePermissionError</span>, <span class="ruby-identifier">base_dir</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">writable?</span> <span class="ruby-identifier">base_dir</span>

  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_rf</span> <span class="ruby-ivar">@rdoc_dir</span>
  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_rf</span> <span class="ruby-ivar">@ri_dir</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-ri_installed-3F" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">ri_installed?</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Is ri data installed?</p>

                              <div class="method-source-code" id="ri_installed-3F-source">
            <pre><span class="ruby-comment"># File rdoc/rubygems_hook.rb, line 232</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ri_installed?</span>
  <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span> <span class="ruby-ivar">@ri_dir</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-setup" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">setup</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Prepares the spec for documentation generation</p>

                              <div class="method-source-code" id="setup-source">
            <pre><span class="ruby-comment"># File rdoc/rubygems_hook.rb, line 239</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setup</span>
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">load_rdoc</span>

  <span class="ruby-identifier">raise</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">FilePermissionError</span>, <span class="ruby-ivar">@doc_dir</span> <span class="ruby-keyword">if</span>
    <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-ivar">@doc_dir</span>) <span class="ruby-keyword">and</span> <span class="ruby-keyword">not</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">writable?</span>(<span class="ruby-ivar">@doc_dir</span>)

  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span> <span class="ruby-ivar">@doc_dir</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span> <span class="ruby-ivar">@doc_dir</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

              </section>
              </main>



            </div>  <!--  class='wrapper hdiv' -->


<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a></p>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.</p>
<p>Based on <a href="https://github.com/ged/darkfish/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>

  
    <p><p><a href="https://ruby-doc.org">Ruby-doc.org</a> is provided by <a href="https://jamesbritt.com">James Britt</a> and <a href="https://neurogami.com">Neurogami</a>. </p><p><a href="https://jamesbritt.bandcamp.com/">Hack your world.  Feed your head.  Live curious</a>.</p>
</p>
  
  </footer>

<script type="text/javascript">


  let ads  = $("#carbonads-container").children().detach();


  function swapMode() {
    var cookieName = 'darkmode';
    var cssDarkmode = Cookies.get(cookieName);
    console.log("***** swapMode! " + cssDarkmode + " *****");


    if (cssDarkmode == "true") {
      console.log("We have dark mode, set the css to light ...");
      $('#rdoccss').attr("href", defaultModeCssHref);
      $('#cssSelect').text("Dark mode");
      cssDarkmode = "false";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    } else {
      console.log("We not have dark mode, set the css to dark ...");
      $('#rdoccss').attr("href", darkModeCsseHref);
      $('#cssSelect').text("Light mode");
      cssDarkmode = "true";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    }

    console.log("  --------------- ");
  }


const vueCssApp = new Vue({
el: '#menubar',
data: {
isDark: false
},
methods: {
toggleClass: function(event){
this.isDark = !this.isDark;
}
}
})

const vueApp = new Vue({
el: '#vapp',
data: { 
isOpen: true
},

mounted() {
this.handleResize();
this.manage_mob_classes();
window.addEventListener('resize', this.handleResize)
//this.isOpen !=  (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},
destroyed() {
window.removeEventListener('resize', this.handleResize)
},
created() {
//manage_mob_classes();
},

methods : {
isMobile() {
  return (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},

  handleResize() {
    if (!this.isMobile()) {
      this.isOpen = window.innerWidth > 800;
    }
  },

  manage_mob_classes() {
    if (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)) {
      $("nav").addClass("mob_nav");
      $("main").addClass("mob_main");
      $("#extraz").addClass("mob_extraz");
      $("#carbonads-container").addClass("mob_carbonads-container");
      this.isOpen  = false;
    } else {
      $("nav").removeClass("mob_nav") 
        $("main").removeClass("mob_main");
      $("#extraz").removeClass("mob_extraz");
      $("#carbonads-container").removeClass("mob_carbonads-container");
      this.isOpen  = true;
    }
  },

  toggleNav() {
    this.isOpen =! this.isOpen ;
    // alert("Toggle nav!");
    console.log("toggleNav() click: " + this.isOpen );
  }
}
})

$("#carbonads-container").append(ads);


$(function() {

    var darkmode = Cookies.get("darkmode");
    console.log("Document ready: " + darkmode);

    if ( darkmode  == "true" ) {
      $('#cssSelect').text("Light mode");
    } else {
      $('#cssSelect').text("Dark mode");
     }

    $('body').css('display','block');
    });

</script>

    
  </body> 
</html>

